<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class tx_zview_helper_Link</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class tx_zview_helper_Link</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Helper to generate a &quot;link&quot; element</p>
	<ul class="tags">
				<li><span class="field">copyright:</span> Copyright (c) Zephir AG, www.zephir.ch</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_helper---Link.php.html">/helper/Link.php</a> (line <span class="field"><a href="../__filesource/fsource_ZView__helperLink.php.html#a17">17</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																				
												<div class="method-definition">
											<span class="method-result">string|<a href="../ZView/tx_zview_helper_Link.html">tx_zview_helper_Link</a></span>
										<a href="#link" title="details" class="method-name">link</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$overrulePIvars</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$clearAnyway</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$altPageId</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setView" title="details" class="method-name">setView</a>
											(<span class="var-type"><a href="../ZView/tx_zview.html">tx_zview</a></span>&nbsp;<span class="var-name">$view</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#thisPage" title="details" class="method-name">thisPage</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$urlParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$altPageId</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#thisPagePIvars" title="details" class="method-name">thisPagePIvars</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$overrulePIvars</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$clearAnyway</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$altPageId</span> = <span class="var-default">0</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#toPage" title="details" class="method-name">toPage</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$urlParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">''</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#toPagePIvars" title="details" class="method-name">toPagePIvars</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$overrulePIvars</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$clearAnyway</span> = <span class="var-default">false</span>])
									</div>
								</div>
		</div>
	</div>		

	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodlink" id="link"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">link</span> (line <span class="line-number"><a href="../__filesource/fsource_ZView__helperLink.php.html#a46">46</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a link to the current page (the caller page) using PI vars.</p>
<p class="description"><p>This is the shortform of link()-&gt;thisPagePIvars().</p><p>If no arguments are passed, returns a tx_zview_helper_Link object.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string|<a href="../ZView/tx_zview_helper_Link.html">tx_zview_helper_Link</a></span>
		<span class="method-name">
			link
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span> = <span class="var-default">''</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$overrulePIvars</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$clearAnyway</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$altPageId</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$overrulePIvars</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$cache</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$clearAnyway</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$altPageId</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetView" id="setView"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setView</span> (line <span class="line-number"><a href="../__filesource/fsource_ZView__helperLink.php.html#a115">115</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Setter for the view object.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setView
		</span>
					(<span class="var-type"><a href="../ZView/tx_zview.html">tx_zview</a></span>&nbsp;<span class="var-name">$view</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../ZView/tx_zview.html">tx_zview</a></span>
				<span class="var-name">$view</span>			</li>
				</ul>
		
			
	</div>
<a name="methodthisPage" id="thisPage"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">thisPage</span> (line <span class="line-number"><a href="../__filesource/fsource_ZView__helperLink.php.html#a92">92</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a link to the current page (the caller page).</p>
	<ul class="tags">
				<li><span class="field">return:</span> The generated link tag</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			thisPage
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$urlParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$altPageId</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$urlParameters</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$cache</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$altPageId</span>			</li>
				</ul>
		
			
	</div>
<a name="methodthisPagePIvars" id="thisPagePIvars"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">thisPagePIvars</span> (line <span class="line-number"><a href="../__filesource/fsource_ZView__helperLink.php.html#a106">106</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a link to the current page (the caller page) using PI vars.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The generated link tag</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			thisPagePIvars
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$overrulePIvars</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$clearAnyway</span> = <span class="var-default">false</span>], [<span class="var-type">integer</span>&nbsp;<span class="var-name">$altPageId</span> = <span class="var-default">0</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$overrulePIvars</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$cache</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$clearAnyway</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$altPageId</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtoPage" id="toPage"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">toPage</span> (line <span class="line-number"><a href="../__filesource/fsource_ZView__helperLink.php.html#a65">65</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a link to a certain page.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The generated link tag</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			toPage
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$urlParameters</span> = <span class="var-default">array()</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$target</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span><span class="var-description">: The label between the a-tags</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$id</span><span class="var-description">: The ID of the target page</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$urlParameters</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$target</span><span class="var-description">: The value for the target attribute</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtoPagePIvars" id="toPagePIvars"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">toPagePIvars</span> (line <span class="line-number"><a href="../__filesource/fsource_ZView__helperLink.php.html#a79">79</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates a link to a certain page using PI vars.</p>
	<ul class="tags">
				<li><span class="field">return:</span> The generated link tag</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			toPagePIvars
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$str</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$overrulePIvars</span> = <span class="var-default">array()</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$cache</span> = <span class="var-default">true</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$clearAnyway</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$str</span>			</li>
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$id</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$overrulePIvars</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$cache</span><span class="var-description">: Using cache or not (1=cached,0=no caching)</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$clearAnyway</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sun, 24 Aug 2008 15:10:45 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.1</a>
	</p>
	</div></body>
</html>